Enum-Klasse DiffGroup.GroupType

java.lang.Object

java.lang.Enum<DiffGroup.GroupType>

com.inet.pdfc.generator.model.DiffGroup.GroupType

Alle implementierten Schnittstellen:

com.inet.pdfc.config.ColorSetting, VisibilitySetting, Serializable, Comparable<DiffGroup.GroupType>, Constable

Umschließende Klasse:

DiffGroup

public static enum DiffGroup.GroupType
extends Enum<DiffGroup.GroupType>
implements com.inet.pdfc.config.ColorSetting

Defines the type of a DiffGroup and thus how to interpret the content of the affected elements lists. The enumeration is ordered in descending order by severity. For further details about each type refer to the respective enum constant.

Seit:

3.0

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen Enum

Enum.EnumDesc<E>

Enum-Konstanten - Übersicht

Enum-Konstanten

Enum-Konstante	Beschreibung
AddedOrRemoved	Contains Modifications which describe a remove in the first document or an add in the second document. NOTE: There is no clear line between this type and 'Replaced'.
MetadataChanged	This type occurs for changes in the meta data or a page or the whole document.
Modified	The modified type indicates that the content in this group is similar on both documents but changed in style.
Replaced	For this type, the Modifications contain elements of similar type and equal style(per side).
Sync	This is an optional type which is added by the generator at any identical locations in the document flow to help any graphical presenter to keep the presented pages in sync.
ValidationError	A validation error is an indicator for a problem on a singular element.

Methodenübersicht

Modifikator und Typ	Methode	Beschreibung
String	getLocalizedName()	Returns the localized name for this type
String	getTyp()	The Visibility Type for this Setting (Enum)
boolean	isTypePainted()	Indicates whether this group type is painted
static DiffGroup.GroupType	valueOf(String name)	Gibt die Enum-Konstante dieser Klasse mit dem angegebenen Namen zurück.
static DiffGroup.GroupType[]	values()	Gibt ein Array mit den Konstanten dieser Enum-Klasse in der Reihenfolge ihrer Deklaration zurück.
static DiffGroup.GroupType[]	valuesVisible()	Returns the groups which should be visible to the user by default.

Von Klasse geerbte Methoden Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Von Klasse geerbte Methoden Object

getClass, notify, notifyAll, wait, wait, wait

Von Schnittstelle geerbte Methoden VisibilitySetting

getTranslationKey, name

Enum-Konstanten - Details

AddedOrRemoved

public static final DiffGroup.GroupType AddedOrRemoved

Contains Modifications which describe a remove in the first document or an add in the second document.
NOTE: There is no clear line between this type and 'Replaced'. The only difference is that this type is likely to contain mixed types of affected elements.

Replaced

public static final DiffGroup.GroupType Replaced

For this type, the Modifications contain elements of similar type and equal style(per side). This type is a special case of AddedOrRemoved. It is very likely but not guaranteed to be a content replacement.

Modified

public static final DiffGroup.GroupType Modified

The modified type indicates that the content in this group is similar on both documents but changed in style. As a result, both all Modification contain the same number of elements and each element is similar to it's counterpart in the other document.

ValidationError

public static final DiffGroup.GroupType ValidationError

A validation error is an indicator for a problem on a singular element. The Element will only be highlighted, but no grouped change should be displayed.

Seit:

5.2

MetadataChanged

public static final DiffGroup.GroupType MetadataChanged

This type occurs for changes in the meta data or a page or the whole document.
NOTE: These elements in this group have artificial bounds to place them at least inside the document area. Their bounds do NOT necessarily represent the bounds of the references pages, the document, etc.

Sync

public static final DiffGroup.GroupType Sync

This is an optional type which is added by the generator at any identical locations in the document flow to help any graphical presenter to keep the presented pages in sync. If you don't need this feature, it's sufficient to ignore this type of groups
The differences count of these groups will always yield zero.

Methodendetails

values

public static DiffGroup.GroupType[] values()

Gibt ein Array mit den Konstanten dieser Enum-Klasse in der Reihenfolge ihrer Deklaration zurück.

Gibt zurück:

ein Array mit den Konstanten dieser Enum-Klasse in der Reihenfolge ihrer Deklaration

valueOf

public static DiffGroup.GroupType valueOf(String name)

Gibt die Enum-Konstante dieser Klasse mit dem angegebenen Namen zurück. Die Zeichenfolge muss exakt mit einer ID übereinstimmen, mit der eine Enum-Konstante in dieser Klasse deklariert wird. (Zusätzliche Leerzeichen sind nicht zulässig.)

Parameter:

name - Name der zurückzugebenden Enumerationskonstante.

Gibt zurück:

Enumerationskonstante mit dem angegebenen Namen

Löst aus:

IllegalArgumentException - wenn diese Enum-Klasse keine Konstante mit dem angegebenen Namen enthält

NullPointerException - wenn das Argument nicht angegeben wird

isTypePainted

public boolean isTypePainted()

Indicates whether this group type is painted

Gibt zurück:

whether this group type is painted

valuesVisible

public static DiffGroup.GroupType[] valuesVisible()

Returns the groups which should be visible to the user by default. This excludes the sync-type for instance.

Gibt zurück:

the groups which should be visible to the user by default

getLocalizedName

public String getLocalizedName()

Returns the localized name for this type

Gibt zurück:

the localized name for this type

getTyp

public String getTyp()

Beschreibung aus Schnittstelle kopiert: VisibilitySetting

The Visibility Type for this Setting (Enum)

Angegeben von:

getTyp in Schnittstelle VisibilitySetting

Gibt zurück:

Type of Enum